<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html>
<html>
<head>
<title>Subversion (svn) in SCM Workbench - User Guide</title>
<meta charset="UTF-8" /> 
<link rel="stylesheet" type="text/css" href="scm-workbench.css" />
<link rev="made" href="mailto:barry@barrys-emacs.org" />
</head>
<body>
<h1><img src="scm-workbench_files/wb.png" width="64px" height="64px" /> Subversion (svn) in SCM Workbench - User Guide</h1>

<p>User guide for the Source Control Mangement (SCM) Workbench.</p>

<p><b>User Guide Sections</b></p>

<ul>
<li><a href="scm-workbench.html">Scm Workbench</a> - gettings started and common shared features.</li>
<li><a href="scm-workbench-git.html">Git in Scm Workbench</a> - git specific menus and features.</li>
<li><a href="scm-workbench-hg.html">Mercurial (hg) in Scm Workbench</a> - Mercurial specific menus and features.</li>
<li><a href="scm-workbench-svn.html">Subversion (svn) in Scm Workbench</a> - Subversion specific menus and features.</li>
</ul>

<p><b>Table of Contents</b></p>

<ul>
<li><a href="#project_settings">Subversion Project settings</a></li>
<li><a href="#menus">Svn Specific Menus</a></li>
</ul>

<h2><a name="project_settings">svn Project settings</a></h2>
<figure>
    <img src="scm-workbench_files/wb_project_settings_svn.png" />
    <figcaption>Svn Project Settings</figcaption>
</figure>

<h3>Name</h3>

<p>The name of the project can be changed by editing the "Name" field.
You must pick a name that is not in use by another project.</p>

<h3>Tag URL</h3>

<p>SCM Workbench can optionally add the names of TAGs to the log history command output.
Enable Tag URL and fill in the path to the tags URL for your repository.</p>

<p>The last element of the URL can be "*" to have Workbench substitute the name
from the next element after trunk.</p>

<p>Note: SCM Workbench uses the revision of the TAG to work out where in the history list the TAG should be shown.
This works very well if TAGs are created from the HEAD of trunk.
</p>

<h2><a name="menus">Svn Menus</a></h2>

<figure>
<table>
<tr><td class="menu_active">Svn Information</td>
    <td class="menu_active">Svn Actions</td></tr>
<td valign="top">
    <div class="menu_dropdown">
    <table><!-- Svn Information -->
    <tr><td><a href="#svn_info_diff_base">Diff Base vs. Working</a></td></tr>
    <tr><td><a href="#svn_info_diff_head">Diff HEAD vs. Working</a></td></tr>
    <tr><td><a href="#svn_info_annotate">Annotate</a></td></tr>
    <tr><td><hr /></td></tr>
    <tr><td><a href="#svn_info_information">Information</a></td></tr>
    <tr><td><a href="#svn_info_properties">Properties</a></td></tr>
    <tr><td><hr /></td></tr>
    <tr><td><a href="#svn_info_log_history">Log history</a></td></tr>
    <tr><td><a href="#svn_info_status">Status</a></td></tr>
    </table></div></td>
<td valign="top">
    <div class="menu_dropdown">
    <table><!-- Svn Actions -->
    <tr><td><a href="#svn_action_add_file">Add file</a></td></tr>
    <tr><td><a href="#svn_action_rename">Rename…</a></td></tr>
    <tr><td><hr /></td></tr>
    <tr><td><a href="#svn_action_add_folder">Add Folder…</a></td></tr>
    <tr><td><a href="#svn_action_new_folder">New Folder…</a></td></tr>
    <tr><td><hr /></td></tr>
    <tr><td><a href="#svn_action_revert">Revert…</a></td></tr>
    <tr><td><a href="#svn_action_delete">Delete…</a></td></tr>
    <tr><td><a href="#svn_action_conflict">Resolve Conflict…</a></td></tr>
    <tr><td><hr /></td></tr>
    <tr><td><a href="#svn_action_lock">Lock…</a></td></tr>
    <tr><td><a href="#svn_action_unlock">Unlock…</a></td></tr>
    <tr><td><hr /></td></tr>
    <tr><td><a href="#svn_action_checkin">Checkin…</a></td></tr>
    <tr><td><hr /></td></tr>
    <tr><td><a href="#svn_action_update">Update</a></td></tr>
    <tr><td><hr /></td></tr>
    <tr><td><a href="#svn_action_cleanup">Cleanup</a></td></tr>
    </table></div></td>
</table>
<figcaption>Subversion menus.</figcaption>
</figure>

<h3><a href="#menus">Menu:</a> <a name="menu_svn_actions">Svn Actions</a></h3>

<h4><a name="svn_info_diff_base"><a href="#menus">Menu:</a> Svn Information » Diff Base vs. Working</a></h4>
<p>Show the differences between the selected files and the checked out BASE version.
In other words show the work you have done.
</p>

<figure>
    <img src="scm-workbench_files/wb_diff_window.png" />
    <figcaption>Diff Window</figcaption>
</figure>

<p>The differences windows shows changed lines and changes within a line.
</p>

<p>By default the diff window has collapsed the folds to hide unmodified text.
</p>

<p>Use the + and - buttons to toggle the collapsing.
</p>
<p>The a.b button toggles the showing of white-space. Useful when looking for
changes in TAB and SPACE characters.</p>

<p>The up and down arrow buttons move you backwards and forwards through each change in the diff window.
</p>

<h4><a name="svn_info_diff_head"><a href="#menus">Menu:</a> Svn Information » Diff HEAD vs. Working</a></h4>

<p>Show the differences between the selected files and the current version in
the repository. In other words show the work other people have checked in
against your version.
</p>

<!--
<h4><a name="svn_action_diff_branch_base"><a href="#menus">Menu:</a> Svn Information » Diff WC vs. branch origin BASE…</a></h4>

<p>
Show the differences between the selected files and their versions at the point this branch was made.
In other words show the work that has been done in this branch.
<br />
An error message is displayed if the active project is not associated with a branch.
</p>

<h4><a name="svn_action_diff_branch_head"><a href="#menus">Menu:</a> Svn Information » Diff WC vs. branch origin HEAD…</a></h4>

<p>
Show the differences between the selected files and their latest versions in the main line of development this branch was copied from.
<br/>
An error message is displayed if the active project is not associated with a branch.
</p>
-->

<h4><a name="svn_info_annotate"><a href="#menus">Menu:</a> Svn Information » Annotate…</a></h4>

<p>Show an annotated listing of the selected file showing the origin of each
line in the file. For each line the author, date and revision is listed.
</p>

<figure>
    <img src="scm-workbench_files/wb_svn_annotate_window.png" />
    <figcaption>Svn Annotate</figcaption>
</figure>

<p>Use this command to discover when a line of interest was introduced into
a file with the commit details.
</p>

<h4><a name="svn_info_information"><a href="#menus">Menu:</a> Svn Information » Information…</a></h4>

<p>Show information about the selected files or folder. The information include details of the
entry, any lock held and working copy details.
</p>

<figure>
    <img src="scm-workbench_files/wb_svn_info_dialog.png" />
    <figcaption>Svn Information Dialog</figcaption>
</figure>

<h4><a name="svn_info_properties"><a href="#menus">Menu:</a> Svn information » Properties…</a></h4>

<p>Show the Subversion properties of the selected files or folder.
</p>

<figure>
    <img src="scm-workbench_files/wb_svn_props_dialog.png" />
    <figcaption>Svn Properties Dialog</figcaption>
</figure>

<p>In the dialog box you can change the properties. The known Subversion
properties are all listed and any user defined. Change the check boxes to
add or remove a property. Fill in the bottom pair of text boxes to define
your own property and value.
</p>

<p>In the example above a user defined property named "foo" has been added with the value "bar".
</p>

<h4><a name="svn_info_log_history"><a href="#menus">Menu:</a> Svn Information » Log history…</a></h4>

<p>List the log history of the selected files or folder. You can choose to
show all the log messages, the last few messages or the messages since a particular
date.
</p>

<figure>
    <img src="scm-workbench_files/wb_commit_log_history_options_dialog.png" />
    <figcaption>Commit log history options</figcaption>
</figure>

<p>The Commit Log window shows an abbreviated listing of all the commit messages.
Select a commit message to display the full commit message and the changed paths.
</p>

<figure>
    <img src="scm-workbench_files/wb_svn_commit_history_window.png" />
    <figcaption>Commit history window</figcaption>
</figure>

<p>By selecting a single revision you can click the Diff button to view the
differences between your copy of the file and the choosen revision.
</p>

<p>By selecting two revisions you can click the Diff button to view the differences
between the pair of selected revisitions.
</p>

<h4><a name="svn_info_status"><a href="#menus">Menu:</a> Svn Information » Status</a></h4>

<p>Show the state of the local repository.</p>

<!-- QQQ -->

<h4><a name="svn_action_add_file"><a href="#menus">Menu:</a> Svn Actions » Add</a></h4>

<p>Schedule the selected files to be added to the repository.
</p>

<h4><a name="svn_action_rename"><a href="#menus">Menu:</a> Svn Actions » Rename…</a></h4>

<p>The Rename command can work on controlled and uncontrolled files.
</p>

<p>Pop up a dialog that allows you to change the name of the selected files and folders.
</p>

<p>SCM Workbench can rename controlled files that have been added or modified.
</p>

<h4><a name="svn_action_add_folder"><a href="#menus">Menu:</a> Svn Actions » Add Folder…</a></h4>
<h4><a name="svn_action_new_folder"><a href="#menus">Menu:</a> Svn Actions » New Folder…</a></h4>

<p>Pop up a dialog that allows you to name a new directory.
</p>

<p>The new directory is scheduler for addition to the repository.
</p>

<h4><a name="svn_action_revert"><a href="#menus">Menu:</a> Svn Actions » Revert…</a></h4>

<p>The Revert command allows you to undo additions and modification to files.
</p>

<p>Added files are left as uncontrolled files. Edits to modified files are lost after a Revert.
</p>

<p>A dialog pops up to confirm the revertion.
</p>

<h4><a name="svn_action_delete"><a href="#menus">Menu:</a> Svn Actions » Delete…</a></h4>

<p>The Delete command can work on controlled and uncontrolled files.
</p>

<p>Uncontrolled files are deleted. Controlled files are scheduled for deletion for the repository.
</p>

<p>A dialog pops up to confirm the deletion.
</p>

<h4><a name="svn_action_conflict"><a href="#menus">Menu:</a> Svn Actions » Resolve Conflict</a></h4>

<p>Tell Subversion that you have resolved the conflict.
</p>

<h4><a name="svn_action_checkin"><a href="#menus">Menu:</a> Svn Actions » Checkin…</a></h4>

<p>Search the selected files or folder for changes to checkin and display the
results in a Checkin Window.
</p>

<figure>
    <img src="scm-workbench_files/wb_svn_new_commit_window.png" />
    <figcaption>Svn Check in Window</figcaption>
</figure>

<p>The Check in window allows you to commit the changes found.
</p>

<p>You can also use commands from this window like Edit, Open, Diff
and Log History to confirm that the changes are as you expect and help
you write a suitable log message.
</p>

<p>The commit will only be allowed if there are changes and the
Commit Log Message is filled in.</p>

<h4><a name="svn_action_update"><a href="#menus">Menu:</a> Svn Actions » Update</a></h4>

<p>Update the selected files or folder from the Subversion repository.
The update will proceed in the background allowing you to do something else in Workbench.
</p>

<p>The status bar will show the progress of the update.
</p>

<h4><a name="svn_action_lock"><a href="#menus">Menu:</a> Svn Actions » Lock…</a></h4>

<p>Take out a lock against the selected files. The dialog box allows
a lock message to be entered. If the lock is already held by another
user and you wish to override the other user's lock selected the Force
check box.
</p>

<h4><a name="svn_action_unlock"><a href="#menus">Menu:</a> Svn Actions » Unlock…</a></h4>

<p>Revoke a lock against the selected files. The dialog box allows you
to confirm that you wish to unlock the file. You can unlock a file that
is locked by another user by selecting the Force check box.
</p>

<h4><a name="svn_action_new_file"><a href="#menus">Menu:</a> Svn Actions » New File…</a></h4>

<p>Pop up a dialog that allows you to name a new file and choose a template to initialised it from.
</p>

<p>The new file is scheduler for addition to the repository.
</p>

<h4><a name="svn_action_cleanup"><a href="#menus">Menu:</a> Svn Actions » Cleanup</a></h4>

<p>If SCM Workbench or a Subversion command did not complete it is possible to leave the working copy in a locked
state (state L).
</p>

<p>Use the CleanUp command to clean up the working copy, removing locks and resuming
unfinished operations.
</p>

<h4><a name="svn_action_create_tag"><a href="#menus">Menu:</a> Svn Actions » Create tag…</a></h4>

<p>Create a tag of the current folder in the project's tags folder.</p>

<p>The tags folder can be configured via the
<tt>Projects</tt> menu <a href="scm-workbench.html#project_settings">Project Settings…</a> dialog.
</p>

<h4><a name="svn_action_create_branch"><a href="#menus">Menu:</a> Svn Actions » Create branch…</a></h4>

<p>Create a branch of the current folder in the project's branches folder.</p>

<p>The branches folder can be configured via the
<tt>Projects</tt> menu <a href="scm-workbench.html#project_settings">Project Settings…</a> dialog.
</p>

<h3><a href="#menus">Menu:</a> Reports</h3>
<h4><a name="report_wc_locks"><a href="#menus">Menu:</a> Reports » Working copy Locks…</a></h4>

<p>Search the selected Working Copy folder and all its sub-folders for locks and display
any found in a new window.
</p>

<p>The Working Copy Lock Report window allows you to Lock and Unlock the files as
well as a set of other useful commands. Use the toolbar buttons or Context-Menu to
access commands.
</p>

<h4><a name="report_repos_locks"><a href="#menus">Menu:</a> Reports » Repository Locks…</a></h4>

<p>Search the selected folder and all its sub-folders in the repository for
locks and display any found in a new window.
</p>

<p>The Repository Lock Report window allows you to Lock and Unlock the files as
well as a set of other useful commands. Use the toolbar buttons or Context-Menu to
access commands.
</p>

<h4><a name="report_updates"><a href="#menus">Menu:</a> Reports » Updates…</a></h4>

<p>Search the selected folder and all its sub-folders in the repository for
changes and display any found in a new window.
</p>

<p>By using the exclude and include buttons you can update a subset of the available
changes.</p>

<h4><a name="report_branch_changes"><a href="#menus">Menu:</a> Reports » Branch changes…</a></h4>

<p>
Creates a list of all changes in and below the current folder that were made in the current branch.
<br/>
An error message is displayed if the active project is not associated with a branch or if no
changes were made to that branch in or below the current folder.
</p>

<hr />
</body>
</html>
